// BandsInTown Java API Client - BandsInTown service interface
// Copyright 2009 PriceFeeder Inc.  All rights reserved.
// http://code.google.com/p/bandsintown-java/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of PriceFeeder Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package com.pricefeeder.bandsintown;

import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;

/**
 * Retrieves concert events from BandsInTown API using the Artists query type.
 * <br /><br />
 * See
 * {@link <a href="http://www.bandsintown.com/api/requests#artists-events">http://www.bandsintown.com/api/requests#artists-events</a>}
 * for more information about this service call.
 * 
 * @author Eli Colner
 * 
 */
public class ArtistsRequest extends BandsInTown {

	/**
	 * The artist to query. (required)
	 */
	private String artist;

	/**
	 * Builds the service call endpoint URL just prior to the time when the
	 * service call occurs according to expected Artists query type parameters.
	 */
	@Override
	protected void preService() {
		url = new StringBuffer();
		url.append(SERVICE_ENDPOINT);
		url.append("/artists");
		String artistName = artist;
		if (artistName.contains("/") || artistName.contains("?")) {
			artistName = encode(artistName);
		}
		url.append("/").append(artistName);
		url.append("/events?format=").append(RESPONSE_FORMAT);
		url.append("&app_id=").append(applicationId);
	}

	/**
	 * Encodes the artist name.
	 * 
	 * @param val
	 *            raw name of artist
	 * @return URL encoded name of artist
	 */
	private String encode(String val) {
		if (val == null)
			return "";
		try {
			return URLEncoder.encode(val, "UTF-8");
		} catch (UnsupportedEncodingException e) {
			logger.error(e);
		}
		return "";
	}

	/**
	 * Occurs just after the service call completes.
	 */
	@Override
	protected void postService() {
		// TODO Auto-generated method stub

	}

	/**
	 * Gets the name of the artist.
	 * 
	 * @return the name of the artist
	 */
	public String getArtist() {
		return artist;
	}

	/**
	 * Sets the name of the artist. (required)
	 * 
	 * @param artist
	 *            the name of the artist or the mbid_<id> (MusicBrainz ID)
	 */
	public void setArtist(String artist) {
		this.artist = artist;
	}
}
